Create Assessment Project
Introduction
The following Assetic REST API endpoint may be used to create a new assessment project.
-
POST /api/v2/assessmentproject
An assessment project can be linked to one or more assessment tasks created against assets. Refer also to the article Create a Project for additional information about assessment projects and how they are created using the Brightly Assetic application itself.
Assessment Project Definition
When creating a new assessment project the following properties are relevant:
| Property | Description | Type | Sample |
| ProjectId | A unique identifier for the assessment project | String | "ProjectId": "PROJ123456" |
| Name | The user-friendly name of the assessment project | String | "Name": "2023 Minor Roads Assessment Project" |
| ProjectManager |
An object containing the "Id" property with the Resource GUID of the manager of the project. See the Get Resources article for additional information on retrieving resource details. |
Object | "ProjectManager": { "Id": "1a0497f6-31dd-e611-946c-06edd62954d7" } |
| Status |
The current status of the assessment project. "Open" (300) "Completed" (500) |
String | "Status": "Open" |
| StartDate | Date the project begins | DateTime | "StartDate": "2023-01-01T00:00:00" |
| EndDate | Date the project ends | DateTime | "EndDate": "2023-01-31T23:59:99" |
| Comments | General comments for the project. 4000 character limit. | String | "Comments": "Example Comment" |
| ProjectType | An object containing the "Id" property of the type of assessment project. Currently restricted to type "1". | Object | "ProjectType": { "Id": 1 } |
NOTE Currently it is not possible to specify the required assessment forms during the creation of an assessment project using the endpoint POST /api/v2/assessmentproject.
Sample Payload
Sample Request
The following is a typical payload used to create a new Assessment Project:
{ "ProjectId": "PROJ123456", "Name": "Assessment Project 2023 - Minor Roads", "ProjectManager": { "Id": "1a0497f6-31dd-e611-946c-06edd62954d7" }, "Status": "Open", "StartDate": "2023-01-01T00:00:00", "EndDate": "2023-01-31T23:59:99", "Comments": "This is a project for the 2023 routine inspection of minor roads.", "ProjectType": { "Id": 1 } }
Sample Response
The response is returned as a collection and includes the generated unique GUID for the project in the "Id" property of the response:
NOTE Currently there is no GET endpoint to retrieve an existing assessment project's GUID. If designing an integration to create assessment tasks linked to a project, an assessment project's GUID contained in the "Id" property of the POST response will need to be captured and saved for future linking purposes.
{ "Data": [ { "Id": "df36dd4f-3220-446b-8b4c-461df4fed17f", "ProjectId": "PROJ123456", "Name": "Assessment Project 2023 - Minor Roads", "ProjectType": { "Id": 1, "Name": null, "Label": null, "_links": [], "_embedded": null }, "StartDate": "2023-01-01T00:00:00", "EndDate": "2023-01-31T23:59:99", "LastModified": "0001-01-01T11:00:00", "ProjectManager": { "Id": "1a0497f6-31dd-e611-946c-06edd62954d7", "DisplayName": null, "_links": [], "_embedded": null }, "Status": 300, "Comments": "This is a project for the 2023 routine inspection of minor roads.", "Priority": 0, "TaskCount": 0, "_links": [], "_embedded": null } ], "Total": 1 }
